-
-
Notifications
You must be signed in to change notification settings - Fork 7.4k
fix(kotlin-client): use enum value in query (#18236) #22929
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: master
Are you sure you want to change the base?
fix(kotlin-client): use enum value in query (#18236) #22929
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
2 issues found across 2 files
Prompt for AI agents (all issues)
Check if these issues are valid — if so, understand the root cause of each and fix them.
<file name="modules/openapi-generator/src/main/resources/kotlin-client/libraries/jvm-spring-webclient/api.mustache">
<violation number="1" location="modules/openapi-generator/src/main/resources/kotlin-client/libraries/jvm-spring-webclient/api.mustache:106">
P2: Enum query parameters now pass raw `.value` into `listOf(...)`, which breaks the `List<String>` type when enum values are non-String (e.g., Int). Generated clients will not compile for such enums.</violation>
</file>
<file name="modules/openapi-generator/src/main/resources/kotlin-client/libraries/jvm-spring-restclient/api.mustache">
<violation number="1" location="modules/openapi-generator/src/main/resources/kotlin-client/libraries/jvm-spring-restclient/api.mustache:104">
P2: Container enum query parameters still serialize via toMultiValue’s default toString() converter, so list/array enums will continue to send enum names instead of their .value. The fix only handles scalar enums and leaves container enums unchanged.</violation>
</file>
Since this is your first cubic review, here's how it works:
- cubic automatically reviews your code and comments on bugs and improvements
- Teach cubic by replying to its comments. cubic learns from your replies and gets better over time
- Ask questions if you need clarification on any suggestion
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.
...enapi-generator/src/main/resources/kotlin-client/libraries/jvm-spring-webclient/api.mustache
Outdated
Show resolved
Hide resolved
| {{^required}} | ||
| if ({{{paramName}}} != null) { | ||
| put("{{baseName}}", {{#isContainer}}toMultiValue({{{paramName}}}.toList(), "{{collectionFormat}}"){{/isContainer}}{{^isContainer}}listOf({{#isDateTime}}parseDateToQueryString({{{paramName}}}){{/isDateTime}}{{#isDate}}parseDateToQueryString({{{paramName}}}){{/isDate}}{{^isDateTime}}{{^isDate}}{{{paramName}}}.toString(){{/isDate}}{{/isDateTime}}){{/isContainer}}) | ||
| put("{{baseName}}", {{#isContainer}}toMultiValue({{{paramName}}}.toList(), "{{collectionFormat}}"){{/isContainer}}{{^isContainer}}listOf({{#isDateTime}}parseDateToQueryString({{{paramName}}}){{/isDateTime}}{{#isDate}}parseDateToQueryString({{{paramName}}}){{/isDate}}{{^isDateTime}}{{^isDate}}{{#isEnumOrRef}}{{{paramName}}}.value{{/isEnumOrRef}}{{^isEnumOrRef}}{{{paramName}}}.toString(){{/isEnumOrRef}}{{/isDate}}{{/isDateTime}}){{/isContainer}}) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
P2: Container enum query parameters still serialize via toMultiValue’s default toString() converter, so list/array enums will continue to send enum names instead of their .value. The fix only handles scalar enums and leaves container enums unchanged.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At modules/openapi-generator/src/main/resources/kotlin-client/libraries/jvm-spring-restclient/api.mustache, line 104:
<comment>Container enum query parameters still serialize via toMultiValue’s default toString() converter, so list/array enums will continue to send enum names instead of their .value. The fix only handles scalar enums and leaves container enums unchanged.</comment>
<file context>
@@ -101,17 +101,17 @@ import {{packageName}}.infrastructure.*
{{^required}}
if ({{{paramName}}} != null) {
- put("{{baseName}}", {{#isContainer}}toMultiValue({{{paramName}}}.toList(), "{{collectionFormat}}"){{/isContainer}}{{^isContainer}}listOf({{#isDateTime}}parseDateToQueryString({{{paramName}}}){{/isDateTime}}{{#isDate}}parseDateToQueryString({{{paramName}}}){{/isDate}}{{^isDateTime}}{{^isDate}}{{{paramName}}}.toString(){{/isDate}}{{/isDateTime}}){{/isContainer}})
+ put("{{baseName}}", {{#isContainer}}toMultiValue({{{paramName}}}.toList(), "{{collectionFormat}}"){{/isContainer}}{{^isContainer}}listOf({{#isDateTime}}parseDateToQueryString({{{paramName}}}){{/isDateTime}}{{#isDate}}parseDateToQueryString({{{paramName}}}){{/isDate}}{{^isDateTime}}{{^isDate}}{{#isEnumOrRef}}{{{paramName}}}.value{{/isEnumOrRef}}{{^isEnumOrRef}}{{{paramName}}}.toString(){{/isEnumOrRef}}{{/isDate}}{{/isDateTime}}){{/isContainer}})
}
{{/required}}
</file context>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
From my understanding container enums are also broken in other implementations (e.g. multiplatform) as well. Might focus on scalar enums in this MR for now. The fix is already an improvement.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
2 issues found across 2 files (changes from recent commits).
Prompt for AI agents (all issues)
Check if these issues are valid — if so, understand the root cause of each and fix them.
<file name="modules/openapi-generator/src/main/resources/kotlin-client/libraries/jvm-spring-restclient/api.mustache">
<violation number="1" location="modules/openapi-generator/src/main/resources/kotlin-client/libraries/jvm-spring-restclient/api.mustache:104">
P2: Enum collections in query parameters are still serialized using toString via toMultiValue, so enum arrays/lists send enum names instead of the enum value, inconsistent with scalar enum handling.</violation>
</file>
<file name="modules/openapi-generator/src/main/resources/kotlin-client/libraries/jvm-spring-webclient/api.mustache">
<violation number="1" location="modules/openapi-generator/src/main/resources/kotlin-client/libraries/jvm-spring-webclient/api.mustache:106">
P2: List/array enum query params still serialize via toMultiValue’s default `$item` conversion, which uses enum name rather than the enum `value`, causing inconsistent and potentially incorrect query values compared to scalar enums.</violation>
</file>
Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.
| {{^required}} | ||
| if ({{{paramName}}} != null) { | ||
| put("{{baseName}}", {{#isContainer}}toMultiValue({{{paramName}}}.toList(), "{{collectionFormat}}"){{/isContainer}}{{^isContainer}}listOf({{#isDateTime}}parseDateToQueryString({{{paramName}}}){{/isDateTime}}{{#isDate}}parseDateToQueryString({{{paramName}}}){{/isDate}}{{^isDateTime}}{{^isDate}}{{{paramName}}}.toString(){{/isDate}}{{/isDateTime}}){{/isContainer}}) | ||
| put("{{baseName}}", {{#isContainer}}toMultiValue({{{paramName}}}.toList(), "{{collectionFormat}}"){{/isContainer}}{{^isContainer}}listOf({{#isDateTime}}parseDateToQueryString({{{paramName}}}){{/isDateTime}}{{#isDate}}parseDateToQueryString({{{paramName}}}){{/isDate}}{{^isDateTime}}{{^isDate}}{{#isEnumOrRef}}"${{{paramName}}}.value}"{{/isEnumOrRef}}{{^isEnumOrRef}}"${{{paramName}}}"{{/isEnumOrRef}}{{/isDate}}{{/isDateTime}}){{/isContainer}}) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
P2: Enum collections in query parameters are still serialized using toString via toMultiValue, so enum arrays/lists send enum names instead of the enum value, inconsistent with scalar enum handling.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At modules/openapi-generator/src/main/resources/kotlin-client/libraries/jvm-spring-restclient/api.mustache, line 104:
<comment>Enum collections in query parameters are still serialized using toString via toMultiValue, so enum arrays/lists send enum names instead of the enum value, inconsistent with scalar enum handling.</comment>
<file context>
@@ -101,17 +101,17 @@ import {{packageName}}.infrastructure.*
{{^required}}
if ({{{paramName}}} != null) {
- put("{{baseName}}", {{#isContainer}}toMultiValue({{{paramName}}}.toList(), "{{collectionFormat}}"){{/isContainer}}{{^isContainer}}listOf({{#isDateTime}}parseDateToQueryString({{{paramName}}}){{/isDateTime}}{{#isDate}}parseDateToQueryString({{{paramName}}}){{/isDate}}{{^isDateTime}}{{^isDate}}{{#isEnumOrRef}}{{{paramName}}}.value{{/isEnumOrRef}}{{^isEnumOrRef}}{{{paramName}}}.toString(){{/isEnumOrRef}}{{/isDate}}{{/isDateTime}}){{/isContainer}})
+ put("{{baseName}}", {{#isContainer}}toMultiValue({{{paramName}}}.toList(), "{{collectionFormat}}"){{/isContainer}}{{^isContainer}}listOf({{#isDateTime}}parseDateToQueryString({{{paramName}}}){{/isDateTime}}{{#isDate}}parseDateToQueryString({{{paramName}}}){{/isDate}}{{^isDateTime}}{{^isDate}}{{#isEnumOrRef}}"${{{paramName}}}.value}"{{/isEnumOrRef}}{{^isEnumOrRef}}"${{{paramName}}}"{{/isEnumOrRef}}{{/isDate}}{{/isDateTime}}){{/isContainer}})
}
{{/required}}
</file context>
| {{^required}} | ||
| if ({{{paramName}}} != null) { | ||
| put("{{baseName}}", {{#isContainer}}toMultiValue({{{paramName}}}.toList(), "{{collectionFormat}}"){{/isContainer}}{{^isContainer}}listOf({{#isDateTime}}parseDateToQueryString({{{paramName}}}){{/isDateTime}}{{#isDate}}parseDateToQueryString({{{paramName}}}){{/isDate}}{{^isDateTime}}{{^isDate}}{{{paramName}}}.toString(){{/isDate}}{{/isDateTime}}){{/isContainer}}) | ||
| put("{{baseName}}", {{#isContainer}}toMultiValue({{{paramName}}}.toList(), "{{collectionFormat}}"){{/isContainer}}{{^isContainer}}listOf({{#isDateTime}}parseDateToQueryString({{{paramName}}}){{/isDateTime}}{{#isDate}}parseDateToQueryString({{{paramName}}}){{/isDate}}{{^isDateTime}}{{^isDate}}{{#isEnumOrRef}}"${{{paramName}}}.value}"{{/isEnumOrRef}}{{^isEnumOrRef}}"${{{paramName}}}"{{/isEnumOrRef}}{{/isDate}}{{/isDateTime}}){{/isContainer}}) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
P2: List/array enum query params still serialize via toMultiValue’s default $item conversion, which uses enum name rather than the enum value, causing inconsistent and potentially incorrect query values compared to scalar enums.
Prompt for AI agents
Check if this issue is valid — if so, understand the root cause and fix it. At modules/openapi-generator/src/main/resources/kotlin-client/libraries/jvm-spring-webclient/api.mustache, line 106:
<comment>List/array enum query params still serialize via toMultiValue’s default `$item` conversion, which uses enum name rather than the enum `value`, causing inconsistent and potentially incorrect query values compared to scalar enums.</comment>
<file context>
@@ -103,17 +103,17 @@ import {{packageName}}.infrastructure.*
{{^required}}
if ({{{paramName}}} != null) {
- put("{{baseName}}", {{#isContainer}}toMultiValue({{{paramName}}}.toList(), "{{collectionFormat}}"){{/isContainer}}{{^isContainer}}listOf({{#isDateTime}}parseDateToQueryString({{{paramName}}}){{/isDateTime}}{{#isDate}}parseDateToQueryString({{{paramName}}}){{/isDate}}{{^isDateTime}}{{^isDate}}{{#isEnumOrRef}}{{{paramName}}}.value{{/isEnumOrRef}}{{^isEnumOrRef}}{{{paramName}}}.toString(){{/isEnumOrRef}}{{/isDate}}{{/isDateTime}}){{/isContainer}})
+ put("{{baseName}}", {{#isContainer}}toMultiValue({{{paramName}}}.toList(), "{{collectionFormat}}"){{/isContainer}}{{^isContainer}}listOf({{#isDateTime}}parseDateToQueryString({{{paramName}}}){{/isDateTime}}{{#isDate}}parseDateToQueryString({{{paramName}}}){{/isDate}}{{^isDateTime}}{{^isDate}}{{#isEnumOrRef}}"${{{paramName}}}.value}"{{/isEnumOrRef}}{{^isEnumOrRef}}"${{{paramName}}}"{{/isEnumOrRef}}{{/isDate}}{{/isDateTime}}){{/isContainer}})
}
{{/required}}
</file context>
|
I am done from my side for now. Let me know if you want anything changed. |
This commit fixes an issue where enums are used as a value in either path or query params due to relying on string casting. With this change, enum values are requested by using .value instead.
I also used kotlin string interpolation to address one of the AI review feedback comments. The change is in line with the multiplatform implementation.
Scope: This MR just fixes issues with scalar enums.
Related to #18236.
PR checklist
Commit all changed files.
This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
These must match the expectations made by your contribution.
You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example
./bin/generate-samples.sh bin/configs/java*.IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
master(upcoming7.x.0minor release - breaking changes with fallbacks),8.0.x(breaking changes without fallbacks)"fixes #123"present in the PR description)Summary by cubic
Fix Kotlin client query parameter handling to use enum.value and Kotlin string interpolation in jvm-spring-restclient and jvm-spring-webclient templates. This ensures correct URL serialization for enums and other values and prevents invalid requests.
Written for commit 09ffa40. Summary will update on new commits.